IRIX Base Documentation 2002 November/SGI IRIX Base Documentation 2002 November.iso/usr/share/catman/p_man/cat3/SCSL/sasum.z/sasum

Text File | 2002-10-03 | 13.9 KB | 331 lines

SSSSAAAASSSSUUUUMMMM((((3333SSSS))))                                                            SSSSAAAASSSSUUUUMMMM((((3333SSSS))))



NNNNAAAAMMMMEEEE
     SSSSAAAASSSSUUUUMMMM, DDDDAAAASSSSUUUUMMMM, SSSSCCCCAAAASSSSUUUUMMMM, DDDDZZZZAAAASSSSUUUUMMMM - Sums the absolute value of elements in a
     real or complex vector

SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
     Single precision

          Fortran:
               rrrreeeeaaaallll SSSSAAAASSSSUUUUMMMM
               rrrreeeeaaaallll _s_u_m
               _s_u_m ==== SSSSAAAASSSSUUUUMMMM ((((_n,,,, _x,,,, _i_n_c_x))))

          C/C++:
               ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
               ffffllllooooaaaatttt ssssaaaassssuuuummmm(((( iiiinnnntttt _n,,,, ffffllllooooaaaatttt *_x,,,, iiiinnnntttt _i_n_c_x ))));;;;

     Double precision

          Fortran:
               ddddoooouuuubbbblllleeee pppprrrreeeecccciiiissssiiiioooonnnn DDDDAAAASSSSUUUUMMMM
               ddddoooouuuubbbblllleeee pppprrrreeeecccciiiissssiiiioooonnnn _s_u_m
               _s_u_m ==== DDDDAAAASSSSUUUUMMMM ((((_n,,,, _x,,,, _i_n_c_x))))

          C/C++:
               ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
               ddddoooouuuubbbblllleeee ddddaaaassssuuuummmm(((( iiiinnnntttt _n,,,, ddddoooouuuubbbblllleeee *_x,,,, iiiinnnntttt _i_n_c_x ))));;;;

     Single precision complex

          Fortran:
               rrrreeeeaaaallll SSSSCCCCAAAASSSSUUUUMMMM
               rrrreeeeaaaallll _s_u_m
               _s_u_m ==== SSSSCCCCAAAASSSSUUUUMMMM ((((_n,,,, _x,,,, _i_n_c_x))))

          C/C++:
               ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
               ffffllllooooaaaatttt ssssccccaaaassssuuuummmm(((( iiiinnnntttt _n,,,, ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_x,,,, iiiinnnntttt _i_n_c_x ))));;;;

          C++ STL:
               ####iiiinnnncccclllluuuuddddeeee <<<<ccccoooommmmpppplllleeeexxxx....hhhh>>>>
               ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
               ffffllllooooaaaatttt ssssccccaaaassssuuuummmm(((( iiiinnnntttt _n,,,, ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_x,,,, iiiinnnntttt _i_n_c_x ))));;;;

     Double precision complex

          Fortran:
               ddddoooouuuubbbblllleeee pppprrrreeeecccciiiissssiiiioooonnnn DDDDZZZZAAAASSSSUUUUMMMM
               ddddoooouuuubbbblllleeee pppprrrreeeecccciiiissssiiiioooonnnn _s_u_m
               _s_u_m ==== DDDDZZZZAAAASSSSUUUUMMMM ((((_n,,,, _x,,,, _i_n_c_x))))






                                                                        PPPPaaaaggggeeee 1111






SSSSAAAASSSSUUUUMMMM((((3333SSSS))))                                                            SSSSAAAASSSSUUUUMMMM((((3333SSSS))))



          C/C++:
               ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
               ddddoooouuuubbbblllleeee ddddzzzzaaaassssuuuummmm(((( iiiinnnntttt _n,,,, ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx *_x,,,, iiiinnnntttt _i_n_c_x ))));;;;

          C++ STL:
               ####iiiinnnncccclllluuuuddddeeee <<<<ccccoooommmmpppplllleeeexxxx....hhhh>>>>
               ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
               ddddoooouuuubbbblllleeee ddddzzzzaaaassssuuuummmm(((( iiiinnnntttt _n,,,, ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>> *_x,,,, iiiinnnntttt _i_n_c_x ))));;;;

IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
     These routines are part of the SCSL Scientific Library and can be loaded
     using either the ----llllssssccccssss or the ----llllssssccccssss____mmmmpppp option.  The ----llllssssccccssss____mmmmpppp option
     directs the linker to use the multi-processor version of the library.

     When linking to SCSL with ----llllssssccccssss or ----llllssssccccssss____mmmmpppp, the default integer size is
     4 bytes (32 bits). Another version of SCSL is available in which integers
     are 8 bytes (64 bits).  This version allows the user access to larger
     memory sizes and helps when porting legacy Cray codes.  It can be loaded
     by using the ----llllssssccccssss____iiii8888 option or the ----llllssssccccssss____iiii8888____mmmmpppp option. A program may use
     only one of the two versions; 4-byte integer and 8-byte integer library
     calls cannot be mixed.

     The C and C++ prototypes shown above are appropriate for the 4-byte
     integer version of SCSL. When using the 8-byte integer version, the
     variables of type iiiinnnntttt become lllloooonnnngggg lllloooonnnngggg and the <<<<ssssccccssssllll____bbbbllllaaaassss____iiii8888....hhhh>>>> header
     file should be included.

DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
     SSSSAAAASSSSUUUUMMMM and DDDDAAAASSSSUUUUMMMM sum the absolute values of the elements of a real vector,
     as follows:

                           n
          sum <- ||x||  = Sum |x |
                      1   i=1   i


     where _x is a real vector of length _n.

     SSSSCCCCAAAASSSSUUUUMMMM and DDDDZZZZAAAASSSSUUUUMMMM sum the absolute values of the real and imaginary parts
     of the elements of a complex vector, as follows:

          sum <- ||Real(x)||  + Imag(x)|| =
                            1            1

                   n                n
                  Sum |Real(x )| + Sum |Imag(x )|
                  i=1        i     j=1        j


     where _x is a complex vector of length _n.





                                                                        PPPPaaaaggggeeee 2222






SSSSAAAASSSSUUUUMMMM((((3333SSSS))))                                                            SSSSAAAASSSSUUUUMMMM((((3333SSSS))))



     For C/C++ arrays, the indices are from 0 to _n-1.

     See the NOTES section of this man page for information about the
     interpretation of the data types described in the following arguments.

     These functions have the following arguments:

     _s_u_m       Sum of values.
               SSSSAAAASSSSUUUUMMMM: Real sum of the absolute values of the elements of _x.
               DDDDAAAASSSSUUUUMMMM: Double precision sum of the absolute values of the
               elements of _x.
               SSSSCCCCAAAASSSSUUUUMMMM: Real sum of the absolute values of the real and
               imaginary parts of the elements of _x.
               DDDDZZZZAAAASSSSUUUUMMMM: Double precision sum of the absolute values of the real
               and imaginary parts of the elements of _x.

     _n         Integer.  (input)
               Number of elements in the vector to be summed.  If _n <= 0,
               these routines return 0.

     _x         Array of dimension (_n-1) * |_i_n_c_x| + 1. (input)
               SSSSAAAASSSSUUUUMMMM: Single precision array.
               DDDDAAAASSSSUUUUMMMM: Double precision array.
               SSSSCCCCAAAASSSSUUUUMMMM: Single precision complex array.
               DDDDZZZZAAAASSSSUUUUMMMM:  Double precision complex array.

               Array _x contains the vector to be summed.

     _i_n_c_x      Integer.  (input)
               Increment between elements of _x.  If _i_n_c_x = 0, the results will
               be unpredictable.

NNNNOOOOTTTTEEEESSSS
     These routines are Level 1 Basic Linear Algebra Subprograms (Level 1
     BLAS).

     When working backward (_i_n_c_x < 0), each routine starts at the end of the
     vector and moves backward, as follows:

     Fortran:

          x(1-incx *(n-1)), x(1incx * (n-2)), ... , x(1)


     C/C++:

          x(1-incx * (n-2)), x(1-incx * (n-3)), ..., x(0)


   DDDDaaaattttaaaa TTTTyyyyppppeeeessss
     The following data types are described in this documentation:




                                                                        PPPPaaaaggggeeee 3333






SSSSAAAASSSSUUUUMMMM((((3333SSSS))))                                                            SSSSAAAASSSSUUUUMMMM((((3333SSSS))))



          TTTTeeeerrrrmmmm UUUUsssseeeedddd                     DDDDaaaattttaaaa ttttyyyyppppeeee

     Fortran:

          Array dimensioned _n           xxxx((((nnnn))))

          Character                     CCCCHHHHAAAARRRRAAAACCCCTTTTEEEERRRR

          Integer                       IIIINNNNTTTTEEEEGGGGEEEERRRR (IIIINNNNTTTTEEEEGGGGEEEERRRR****8888 for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])

          Single precision              RRRREEEEAAAALLLL

          Double precision              DDDDOOOOUUUUBBBBLLLLEEEE PPPPRRRREEEECCCCIIIISSSSIIIIOOOONNNN

          Single precision complex      CCCCOOOOMMMMPPPPLLLLEEEEXXXX

          Double precision complex      DDDDOOOOUUUUBBBBLLLLEEEE CCCCOOOOMMMMPPPPLLLLEEEEXXXX

     C/C++:

          Array dimensioned _n           xxxx[[[[_n]]]]

          Character                     cccchhhhaaaarrrr

          Integer                       iiiinnnntttt (lllloooonnnngggg lllloooonnnngggg for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])

          Single precision              ffffllllooooaaaatttt

          Double precision              ddddoooouuuubbbblllleeee

          Single precision complex      ssssccccssssllll____ccccoooommmmpppplllleeeexxxx

          Double precision complex      ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx

     C++ STL:

          Array dimensioned _n           xxxx[[[[_n]]]]

          Character                     cccchhhhaaaarrrr

          Integer                       iiiinnnntttt (lllloooonnnngggg lllloooonnnngggg for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])

          Single precision              ffffllllooooaaaatttt

          Double precision              ddddoooouuuubbbblllleeee

          Single precision complex      ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>>

          Double precision complex      ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>>






                                                                        PPPPaaaaggggeeee 4444






SSSSAAAASSSSUUUUMMMM((((3333SSSS))))                                                            SSSSAAAASSSSUUUUMMMM((((3333SSSS))))



SSSSEEEEEEEE AAAALLLLSSSSOOOO
     IIIINNNNTTTTRRRROOOO____SSSSCCCCSSSSLLLL(3S), IIIINNNNTTTTRRRROOOO____BBBBLLLLAAAASSSS1111(3S)

     IIIINNNNTTTTRRRROOOO____CCCCBBBBLLLLAAAASSSS(3S) for information about using the C interface to Fortran 77
     Basic Linear Algebra Subprograms (legacy BLAS) set forth by the Basic
     Linear Algebra Subprograms Technical Forum.














































                                                                        PPPPaaaaggggeeee 5555